home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3x / curs_util.z / curs_util
Encoding:
Text File  |  1998-10-20  |  8.2 KB  |  129 lines
  1.  
  2.  
  3.  
  4. ccccuuuurrrrssss____uuuuttttiiiillll((((3333XXXX))))                                                    ccccuuuurrrrssss____uuuuttttiiiillll((((3333XXXX))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_uuuu_rrrr_ssss______uuuu_tttt_iiii_llll:  _uuuu_nnnn_cccc_tttt_rrrr_llll, _kkkk_eeee_yyyy_nnnn_aaaa_mmmm_eeee, _ffff_iiii_llll_tttt_eeee_rrrr, _uuuu_ssss_eeee______eeee_nnnn_vvvv, _pppp_uuuu_tttt_wwww_iiii_nnnn, _gggg_eeee_tttt_wwww_iiii_nnnn,
  10.      _dddd_eeee_llll_aaaa_yyyy______oooo_uuuu_tttt_pppp_uuuu_tttt, _dddd_rrrr_aaaa_iiii_nnnn_oooo, _ffff_llll_uuuu_ssss_hhhh_iiii_nnnn_pppp - miscellaneous _cccc_uuuu_rrrr_ssss_eeee_ssss utility routines
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>>
  14.  
  15.      _cccc_hhhh_aaaa_rrrr _****_uuuu_nnnn_cccc_tttt_rrrr_llll_((((_cccc_hhhh_tttt_yyyy_pppp_eeee _cccc_))))_;;;;
  16.      _cccc_hhhh_aaaa_rrrr _****_kkkk_eeee_yyyy_nnnn_aaaa_mmmm_eeee_((((_iiii_nnnn_tttt _cccc_))))_;;;;
  17.      _iiii_nnnn_tttt _ffff_iiii_llll_tttt_eeee_rrrr_((((_vvvv_oooo_iiii_dddd_))))_;;;;
  18.      _vvvv_oooo_iiii_dddd _uuuu_ssss_eeee______eeee_nnnn_vvvv_((((_cccc_hhhh_aaaa_rrrr _bbbb_oooo_oooo_llll_))))_;;;;
  19.      _iiii_nnnn_tttt _pppp_uuuu_tttt_wwww_iiii_nnnn_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _FFFF_IIII_LLLL_EEEE _****_ffff_iiii_llll_eeee_pppp_))))_;;;;
  20.      _WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_gggg_eeee_tttt_wwww_iiii_nnnn_((((_FFFF_IIII_LLLL_EEEE _****_ffff_iiii_llll_eeee_pppp_))))_;;;;
  21.      _iiii_nnnn_tttt _dddd_eeee_llll_aaaa_yyyy______oooo_uuuu_tttt_pppp_uuuu_tttt_((((_iiii_nnnn_tttt _mmmm_ssss_))))_;;;;
  22.      _iiii_nnnn_tttt _dddd_rrrr_aaaa_iiii_nnnn_oooo_((((_iiii_nnnn_tttt _mmmm_ssss_))))_;;;;
  23.      _iiii_nnnn_tttt _ffff_llll_uuuu_ssss_hhhh_iiii_nnnn_pppp_((((_vvvv_oooo_iiii_dddd_))))_;;;;
  24.  
  25. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.      The _uuuu_nnnn_cccc_tttt_rrrr_llll macro expands to a character string which is a printable
  27.      representation of the character _c.  Control characters are displayed in
  28.      the _^^^^_X notation.  Printing characters are displayed as is.
  29.  
  30.      With the _kkkk_eeee_yyyy_nnnn_aaaa_mmmm_eeee routine, a character string corresponding to the key _c
  31.      is returned.
  32.  
  33.      The _ffff_iiii_llll_tttt_eeee_rrrr routine, if used, is called before _iiii_nnnn_iiii_tttt_ssss_cccc_rrrr or _nnnn_eeee_wwww_tttt_eeee_rrrr_mmmm are
  34.      called.  It makes _cccc_uuuu_rrrr_ssss_eeee_ssss think that there is a one-line screen.  _cccc_uuuu_rrrr_ssss_eeee_ssss
  35.      does not use any terminal capabilities that assume that they know on what
  36.      line of the screen the cursor is positioned.
  37.  
  38.      The _uuuu_ssss_eeee______eeee_nnnn_vvvv routine, if used, is called before _iiii_nnnn_iiii_tttt_ssss_cccc_rrrr or _nnnn_eeee_wwww_tttt_eeee_rrrr_mmmm are
  39.      called.  When called with _FFFF_AAAA_LLLL_SSSS_EEEE as an argument, the values of _llll_iiii_nnnn_eeee_ssss and
  40.      _cccc_oooo_llll_uuuu_mmmm_nnnn_ssss specified in the _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database will be used, even if
  41.      environment variables _LLLL_IIII_NNNN_EEEE_SSSS and _CCCC_OOOO_LLLL_UUUU_MMMM_NNNN_SSSS (used by default) are set, or if
  42.      _cccc_uuuu_rrrr_ssss_eeee_ssss is running in a window (in which case default behavior would be to
  43.      use the window size if _LLLL_IIII_NNNN_EEEE_SSSS and _CCCC_OOOO_LLLL_UUUU_MMMM_NNNN_SSSS are not set).
  44.  
  45.      With the _pppp_uuuu_tttt_wwww_iiii_nnnn routine, all data associated with window _w_i_n is written
  46.      into the file to which _f_i_l_e_p points.  This information can be later
  47.      retrieved using the _gggg_eeee_tttt_wwww_iiii_nnnn function.
  48.  
  49.      The _gggg_eeee_tttt_wwww_iiii_nnnn routine reads window related data stored in the file by
  50.      _pppp_uuuu_tttt_wwww_iiii_nnnn.  The routine then creates and initializes a new window using that
  51.      data.  It returns a pointer to the new window.
  52.  
  53.      The _dddd_eeee_llll_aaaa_yyyy______oooo_uuuu_tttt_pppp_uuuu_tttt routine inserts an _m_s millisecond pause in output.  This
  54.      routine should not be used extensively because padding characters are
  55.      used rather than a CPU pause.
  56.  
  57.  
  58.  
  59.                                                                         PPPPaaaaggggeeee 1111
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66. ccccuuuurrrrssss____uuuuttttiiiillll((((3333XXXX))))                                                    ccccuuuurrrrssss____uuuuttttiiiillll((((3333XXXX))))
  67.  
  68.  
  69.  
  70.      The _dddd_rrrr_aaaa_iiii_nnnn_oooo routine returns when _m_s are needed to clear the output
  71.      completely.  Current valid value for _m_s is 0.
  72.  
  73.      The _ffff_llll_uuuu_ssss_hhhh_iiii_nnnn_pppp routine throws away any typeahead that has been typed by the
  74.      user and has not yet been read by the program.
  75.  
  76. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  77.      Except for _ffff_llll_uuuu_ssss_hhhh_iiii_nnnn_pppp, routines that return an integer return _EEEE_RRRR_RRRR upon
  78.      failure and an integer value other than _EEEE_RRRR_RRRR upon successful completion.
  79.  
  80.      _ffff_llll_uuuu_ssss_hhhh_iiii_nnnn_pppp always returns _OOOO_KKKK.
  81.  
  82.      Routines that return pointers return _NNNN_UUUU_LLLL_LLLL on error.
  83.  
  84. NNNNOOOOTTTTEEEESSSS
  85.      The header file _cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh automatically includes the header files _ssss_tttt_dddd_iiii_oooo_...._hhhh
  86.      and _uuuu_nnnn_cccc_tttt_rrrr_llll_...._hhhh.
  87.  
  88.      Note that _uuuu_nnnn_cccc_tttt_rrrr_llll is a macro, which is defined in _uuuu_nnnn_cccc_tttt_rrrr_llll_...._hhhh.
  89.  
  90. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  91.      _cccc_uuuu_rrrr_ssss_eeee_ssss(3X), _cccc_uuuu_rrrr_ssss______iiii_nnnn_iiii_tttt_ssss_cccc_rrrr(3X), _cccc_uuuu_rrrr_ssss______ssss_cccc_rrrr______dddd_uuuu_mmmm_pppp(3X)
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.                                                                         PPPPaaaaggggeeee 2222
  126.  
  127.  
  128.  
  129.